fragment/androidx.fragment.app/[main]Fragment

Fragment

open class Fragment : ComponentCallbacks, View.OnCreateContextMenuListener, LifecycleOwner, ViewModelStoreOwner, HasDefaultViewModelProviderFactory, SavedStateRegistryOwner, ActivityResultCaller(source)

Static library support version of the framework's android.app.Fragment. Used to write apps that run on platforms prior to Android 3.0. When running on Android 3.0 or above, this implementation is still used; it does not try to switch to the framework's implementation. See the framework android.app.Fragment documentation for a class overview.

The main differences when using this support version instead of the framework version are:

Inheritors

Constructors

Link copied to clipboard
constructor()
Constructor used by the default FragmentFactory.
constructor(@LayoutRes contentLayoutId: Int)
Alternate constructor that can be called from your default, no argument constructor to provide a default layout that will be inflated by onCreateView.

Types

Link copied to clipboard
open class InstantiationException : RuntimeException
Thrown by instantiate when there is an instantiation failure.
Link copied to clipboard
open class SavedState : Parcelable
State information that has been retrieved from a fragment instance through FragmentManager.saveFragmentInstanceState.

Properties

Link copied to clipboard

Functions

Link copied to clipboard
open fun dump(@NonNull prefix: String, @Nullable fd: FileDescriptor, @NonNull writer: PrintWriter, @Nullable args: Array<String>)
Print the Fragments's state into the given stream.
Link copied to clipboard
fun equals(@Nullable o: Any): Boolean
Subclasses can not override equals().
Link copied to clipboard
@Nullable
fun getActivity(): FragmentActivity
Return the FragmentActivity this fragment is currently associated with.
Link copied to clipboard
open fun getAllowEnterTransitionOverlap(): Boolean
Returns whether the the exit transition and enter transition overlap or not.
Link copied to clipboard
open fun getAllowReturnTransitionOverlap(): Boolean
Returns whether the the return transition and reenter transition overlap or not.
Link copied to clipboard
@Nullable
fun getArguments(): Bundle
Return the arguments supplied when the fragment was instantiated, if any.
Link copied to clipboard
@NonNull
fun getChildFragmentManager(): FragmentManager
Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
Link copied to clipboard
@Nullable
open fun getContext(): Context
Return the Context this fragment is currently associated with.
Link copied to clipboard
@NonNull
@CallSuper
open fun getDefaultViewModelCreationExtras(): CreationExtras
The Fragment's arguments when this is first called will be used as the defaults to any androidx.lifecycle.SavedStateHandle passed to a view model created using this extra.
Link copied to clipboard
Link copied to clipboard
@Nullable
open fun getEnterTransition(): Any
Returns the Transition that will be used to move Views into the initial scene.
Link copied to clipboard
@Nullable
open fun getExitTransition(): Any
Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
Link copied to clipboard
@Nullable
fun getFragmentManager(): FragmentManager
Return the FragmentManager for interacting with fragments associated with this fragment's activity.
Link copied to clipboard
@Nullable
fun getHost(): Any
Return the host object of this fragment.
Link copied to clipboard
fun getId(): Int
Return the identifier this fragment is known by.
Link copied to clipboard
@NonNull
fun getLayoutInflater(): LayoutInflater
Returns the cached LayoutInflater used to inflate Views of this Fragment.
@NonNull
@RestrictTo(value = LIBRARY_GROUP_PREFIX)
open fun getLayoutInflater(@Nullable savedFragmentState: Bundle): LayoutInflater
Override onGetLayoutInflater when you need to change the LayoutInflater or call getLayoutInflater when you want to retrieve the current LayoutInflater.
Link copied to clipboard
@NonNull
open fun getLifecycle(): Lifecycle
Overriding this method is no longer supported and this method will be made final in a future version of Fragment.
Link copied to clipboard
@NonNull
open fun getLoaderManager(): LoaderManager
Return the LoaderManager for this fragment.
Link copied to clipboard
@Nullable
fun getParentFragment(): Fragment
Returns the parent Fragment containing this Fragment.
Link copied to clipboard
@NonNull
fun getParentFragmentManager(): FragmentManager
Return the FragmentManager for interacting with fragments associated with this fragment's activity.
Link copied to clipboard
@Nullable
open fun getReenterTransition(): Any
Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
Link copied to clipboard
@NonNull
fun getResources(): Resources
Return requireActivity().getResources().
Link copied to clipboard
fun getRetainInstance(): Boolean
Returns true if this fragment instance's state will be retained across configuration changes, and false if it will not.
Link copied to clipboard
@Nullable
open fun getReturnTransition(): Any
Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
Link copied to clipboard
Link copied to clipboard
@Nullable
open fun getSharedElementEnterTransition(): Any
Returns the Transition that will be used for shared elements transferred into the content Scene.
Link copied to clipboard
@Nullable
open fun getSharedElementReturnTransition(): Any
Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
Link copied to clipboard
@NonNull
fun getString(@StringRes resId: Int): String
Return a localized string from the application's package's default string table.
@NonNull
fun getString(@StringRes resId: Int, @Nullable formatArgs: Array<Any>): String
Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in java.util.Formatter and format.
Link copied to clipboard
@Nullable
fun getTag(): String
Get the tag name of the fragment, if specified.
Link copied to clipboard
@Nullable
fun getTargetFragment(): Fragment
Return the target fragment set by setTargetFragment.
Link copied to clipboard
fun getTargetRequestCode(): Int
Return the target request code set by setTargetFragment.
Link copied to clipboard
@NonNull
fun getText(@StringRes resId: Int): CharSequence
Return a localized, styled CharSequence from the application's package's default string table.
Link copied to clipboard
Link copied to clipboard
@Nullable
open fun getView(): View
Get the root view for the fragment's layout (the one returned by onCreateView), if provided.
Link copied to clipboard
@MainThread
@NonNull
open fun getViewLifecycleOwner(): LifecycleOwner
Get a LifecycleOwner that represents the Fragment's View lifecycle.
Link copied to clipboard
Link copied to clipboard
@NonNull
open fun getViewModelStore(): ViewModelStore
Returns the ViewModelStore associated with this Fragment Overriding this method is no longer supported and this method will be made final in a future version of Fragment.
Link copied to clipboard
fun hashCode(): Int
Subclasses can not override hashCode().
Link copied to clipboard
Link copied to clipboard
@NonNull
open fun instantiate(@NonNull context: Context, @NonNull fname: String): Fragment
Like instantiate but with a null argument Bundle.
@NonNull
open fun instantiate(@NonNull context: Context, @NonNull fname: String, @Nullable args: Bundle): Fragment
Create a new instance of a Fragment with the given class name.
Link copied to clipboard
fun isAdded(): Boolean
Return true if the fragment is currently added to its activity.
Link copied to clipboard
fun isDetached(): Boolean
Return true if the fragment has been explicitly detached from the UI.
Link copied to clipboard
fun isHidden(): Boolean
Return true if the fragment has been hidden.
Link copied to clipboard
fun isInLayout(): Boolean
Return true if the layout is included as part of an activity view hierarchy via the tag.
Link copied to clipboard
Link copied to clipboard
fun isRemoving(): Boolean
Return true if this fragment is currently being removed from its activity.
Link copied to clipboard
fun isResumed(): Boolean
Return true if the fragment is in the resumed state.
Link copied to clipboard
fun isStateSaved(): Boolean
Returns true if this fragment is added and its state has already been saved by its host.
Link copied to clipboard
fun isVisible(): Boolean
Return true if the fragment is currently visible to the user.
Link copied to clipboard
@MainThread
@CallSuper
open fun onActivityCreated(@Nullable savedInstanceState: Bundle)
Called when the fragment's activity has been created and this fragment's view hierarchy instantiated.
Link copied to clipboard
open fun onActivityResult(requestCode: Int, resultCode: Int, @Nullable data: Intent)
Receive the result from a previous call to startActivityForResult.
Link copied to clipboard
@MainThread
@CallSuper
open fun onAttach(@NonNull activity: Activity)
Called when a fragment is first attached to its activity.
@MainThread
@CallSuper
open fun onAttach(@NonNull context: Context)
Called when a fragment is first attached to its context.
Link copied to clipboard
@MainThread
open fun onAttachFragment(@NonNull childFragment: Fragment)
Called when a fragment is attached as a child of this fragment.
Link copied to clipboard
Link copied to clipboard
@MainThread
open fun onContextItemSelected(@NonNull item: MenuItem): Boolean
This hook is called whenever an item in a context menu is selected.
Link copied to clipboard
@MainThread
@CallSuper
open fun onCreate(@Nullable savedInstanceState: Bundle)
Called to do initial creation of a fragment.
Link copied to clipboard
@MainThread
@Nullable
open fun onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int): Animation
Called when a fragment loads an animation.
Link copied to clipboard
@MainThread
@Nullable
open fun onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int): Animator
Called when a fragment loads an animator.
Link copied to clipboard
@MainThread
open fun onCreateContextMenu(@NonNull menu: ContextMenu, @NonNull v: View, @Nullable menuInfo: ContextMenu.ContextMenuInfo)
Called when a context menu for the view is about to be shown.
Link copied to clipboard
@MainThread
open fun onCreateOptionsMenu(@NonNull menu: Menu, @NonNull inflater: MenuInflater)
Initialize the contents of the Fragment host's standard options menu.
Link copied to clipboard
@MainThread
@Nullable
open fun onCreateView(@NonNull inflater: LayoutInflater, @Nullable container: ViewGroup, @Nullable savedInstanceState: Bundle): View
Called to have the fragment instantiate its user interface view.
Link copied to clipboard
@MainThread
@CallSuper
open fun onDestroy()
Called when the fragment is no longer in use.
Link copied to clipboard
@MainThread
open fun onDestroyOptionsMenu()
Called when this fragment's option menu items are no longer being included in the overall options menu.
Link copied to clipboard
@MainThread
@CallSuper
open fun onDestroyView()
Called when the view previously created by onCreateView has been detached from the fragment.
Link copied to clipboard
@MainThread
@CallSuper
open fun onDetach()
Called when the fragment is no longer attached to its activity.
Link copied to clipboard
@NonNull
open fun onGetLayoutInflater(@Nullable savedInstanceState: Bundle): LayoutInflater
Returns the LayoutInflater used to inflate Views of this Fragment.
Link copied to clipboard
@MainThread
open fun onHiddenChanged(hidden: Boolean)
Called when the hidden state (as returned by isHidden of the fragment or another fragment in its hierarchy has changed.
Link copied to clipboard
@UiThread
@CallSuper
open fun onInflate(@NonNull activity: Activity, @NonNull attrs: AttributeSet, @Nullable savedInstanceState: Bundle)
@UiThread
@CallSuper
open fun onInflate(@NonNull context: Context, @NonNull attrs: AttributeSet, @Nullable savedInstanceState: Bundle)
Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
Link copied to clipboard
Link copied to clipboard
open fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean)
Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
Link copied to clipboard
@MainThread
open fun onOptionsItemSelected(@NonNull item: MenuItem): Boolean
This hook is called whenever an item in your options menu is selected.
Link copied to clipboard
@MainThread
open fun onOptionsMenuClosed(@NonNull menu: Menu)
This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected).
Link copied to clipboard
@MainThread
@CallSuper
open fun onPause()
Called when the Fragment is no longer resumed.
Link copied to clipboard
open fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)
Called by the system when the activity changes to and from picture-in-picture mode.
Link copied to clipboard
@MainThread
open fun onPrepareOptionsMenu(@NonNull menu: Menu)
Prepare the Fragment host's standard options menu to be displayed.
Link copied to clipboard
@MainThread
open fun onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean)
Callback for when the primary navigation state of this Fragment has changed.
Link copied to clipboard
open fun onRequestPermissionsResult(requestCode: Int, @NonNull permissions: Array<String>, @NonNull grantResults: Array<Int>)
Callback for the result from requesting permissions.
Link copied to clipboard
@MainThread
@CallSuper
open fun onResume()
Called when the fragment is visible to the user and actively running.
Link copied to clipboard
@MainThread
open fun onSaveInstanceState(@NonNull outState: Bundle)
Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance if its process is restarted.
Link copied to clipboard
@MainThread
@CallSuper
open fun onStart()
Called when the Fragment is visible to the user.
Link copied to clipboard
@MainThread
@CallSuper
open fun onStop()
Called when the Fragment is no longer started.
Link copied to clipboard
@MainThread
open fun onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle)
Called immediately after onCreateView has returned, but before any saved state has been restored in to the view.
Link copied to clipboard
@MainThread
@CallSuper
open fun onViewStateRestored(@Nullable savedInstanceState: Bundle)
Called when all saved state has been restored into the view hierarchy of the fragment.
Link copied to clipboard
open fun postponeEnterTransition()
Postpone the entering Fragment transition until startPostponedEnterTransition or executePendingTransactions has been called.
fun postponeEnterTransition(duration: Long, @NonNull timeUnit: TimeUnit)
Postpone the entering Fragment transition for a given amount of time and then call startPostponedEnterTransition.
Link copied to clipboard
Link copied to clipboard
open fun registerForContextMenu(@NonNull view: View)
Registers a context menu to be shown for the given view (multiple views can show the context menu).
Link copied to clipboard
fun requestPermissions(@NonNull permissions: Array<String>, requestCode: Int)
Requests permissions to be granted to this application.
Link copied to clipboard
@NonNull
fun requireActivity(): FragmentActivity
Return the FragmentActivity this fragment is currently associated with.
Link copied to clipboard
@NonNull
fun requireArguments(): Bundle
Return the arguments supplied when the fragment was instantiated.
Link copied to clipboard
@NonNull
fun requireContext(): Context
Return the Context this fragment is currently associated with.
Link copied to clipboard
@NonNull
fun requireFragmentManager(): FragmentManager
Return the FragmentManager for interacting with fragments associated with this fragment's activity.
Link copied to clipboard
@NonNull
fun requireHost(): Any
Return the host object of this fragment.
Link copied to clipboard
@NonNull
fun requireParentFragment(): Fragment
Returns the parent Fragment containing this Fragment.
Link copied to clipboard
@NonNull
fun requireView(): View
Get the root view for the fragment's layout (the one returned by onCreateView).
Link copied to clipboard
open fun setAllowEnterTransitionOverlap(allow: Boolean)
Sets whether the the exit transition and enter transition overlap or not.
Link copied to clipboard
open fun setAllowReturnTransitionOverlap(allow: Boolean)
Sets whether the the return transition and reenter transition overlap or not.
Link copied to clipboard
open fun setArguments(@Nullable args: Bundle)
Supply the construction arguments for this fragment.
Link copied to clipboard
open fun setEnterSharedElementCallback(@Nullable callback: SharedElementCallback)
When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.
Link copied to clipboard
open fun setEnterTransition(@Nullable transition: Any)
Sets the Transition that will be used to move Views into the initial scene.
Link copied to clipboard
open fun setExitSharedElementCallback(@Nullable callback: SharedElementCallback)
When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.
Link copied to clipboard
open fun setExitTransition(@Nullable transition: Any)
Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
Link copied to clipboard
open fun setHasOptionsMenu(hasMenu: Boolean)
Report that this fragment would like to participate in populating the options menu by receiving a call to onCreateOptionsMenu and related methods.
Link copied to clipboard
open fun setInitialSavedState(@Nullable state: Fragment.SavedState)
Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by FragmentManager.saveFragmentInstanceState.
Link copied to clipboard
open fun setMenuVisibility(menuVisible: Boolean)
Set a hint for whether this fragment's menu should be visible.
Link copied to clipboard
open fun setReenterTransition(@Nullable transition: Any)
Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
Link copied to clipboard
open fun setRetainInstance(retain: Boolean)
Control whether a fragment instance is retained across Activity re-creation (such as from a configuration change).
Link copied to clipboard
open fun setReturnTransition(@Nullable transition: Any)
Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
Link copied to clipboard
open fun setSharedElementEnterTransition(@Nullable transition: Any)
Sets the Transition that will be used for shared elements transferred into the content Scene.
Link copied to clipboard
open fun setSharedElementReturnTransition(@Nullable transition: Any)
Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
Link copied to clipboard
open fun setTargetFragment(@Nullable fragment: Fragment, requestCode: Int)
Optional target for this fragment.
Link copied to clipboard
open fun setUserVisibleHint(isVisibleToUser: Boolean)
Set a hint to the system about whether this fragment's UI is currently visible to the user.
Link copied to clipboard
open fun shouldShowRequestPermissionRationale(@NonNull permission: String): Boolean
Gets whether you should show UI with rationale before requesting a permission.
Link copied to clipboard
open fun startActivity(@NonNull intent: Intent)
open fun startActivity(@NonNull intent: Intent, @Nullable options: Bundle)
Call startActivity from the fragment's containing Activity.
Link copied to clipboard
open fun startActivityForResult(@NonNull intent: Intent, requestCode: Int)
open fun startActivityForResult(@NonNull intent: Intent, requestCode: Int, @Nullable options: Bundle)
Call startActivityForResult from the fragment's containing Activity.
Link copied to clipboard
open fun startIntentSenderForResult(@NonNull intent: IntentSender, requestCode: Int, @Nullable fillInIntent: Intent, flagsMask: Int, flagsValues: Int, extraFlags: Int, @Nullable options: Bundle)
Call startIntentSenderForResult from the fragment's containing Activity.
Link copied to clipboard
open fun startPostponedEnterTransition()
Begin postponed transitions after postponeEnterTransition was called.
Link copied to clipboard
@NonNull
open fun toString(): String
Link copied to clipboard
open fun unregisterForContextMenu(@NonNull view: View)
Prevents a context menu to be shown for the given view.